GetValue<T>(DicomElement,Boolean,Int64,T,GetValueDelegate) Method

Public Class PersonName
   Private _innerArray As String() = New String(4) {String.Empty, String.Empty, String.Empty, String.Empty, String.Empty }
   ''' Access this person name instance as array. Index range is
   ''' bounded between 0 (family name) and 4 (name suffix).
   Public Default Property Item(ByVal index As Integer) As String
      Set
         If Value Is Nothing OrElse Value.Length < 64 Then
            _innerArray(index) = Value
         Else
            Throw New DicomException("Length of new entry exceeds 64 characters.")
         End If
      End Set

      Get
         Return _innerArray(index)
      End Get
   End Property

   Private Const _familyNameIndex As Integer = 0
   Private Const _givenNameIndex As Integer = 1
   Private Const _middleNameIndex As Integer = 2
   Private Const _namePrefixIndex As Integer = 3
   Private Const _nameSuffixIndex As Integer = 4

   ''' Access person name part family name.
   Public Property FamilyName() As String
      Set
         If Value Is Nothing OrElse Value.Length < 64 Then
            _fullName = Nothing
            _innerArray(_familyNameIndex) = Value
         Else
            Throw New DicomException("Length of family name exceeds 64 characters.")
         End If
      End Set

      Get
         Return _innerArray(_familyNameIndex)
      End Get
   End Property

   ''' Access person name part given name.
   Public Property GivenName() As String
      Set
         If Value Is Nothing OrElse Value.Length < 64 Then
            _fullName = String.Empty
            _innerArray(_givenNameIndex) = Value
         Else
            Throw New DicomException("Length of family name exceeds 64 characters.")
         End If
      End Set

      Get
         Return _innerArray(_givenNameIndex)
      End Get
   End Property

   ''' Access person name part middle name.
   Public Property MiddleName() As String
      Set
         If Value Is Nothing OrElse Value.Length < 64 Then
            _fullName = String.Empty
            _innerArray(_middleNameIndex) = Value
         Else
            Throw New DicomException("Length of family name exceeds 64 characters.")
         End If
      End Set

      Get
         Return _innerArray(_middleNameIndex)
      End Get
   End Property

   ''' Access person name part name prefix.
   Public Property NamePrefix() As String
      Set
         If Value Is Nothing OrElse Value.Length < 64 Then
            _fullName = String.Empty
            _innerArray(_namePrefixIndex) = Value
         Else
            Throw New DicomException("Length of family name exceeds 64 characters.")
         End If
      End Set

      Get
         Return _innerArray(_namePrefixIndex)
      End Get
   End Property

   ''' Access person name part name suffix.
   Public Property NameSuffix() As String
      Set
         If Value Is Nothing OrElse Value.Length < 64 Then
            _fullName = String.Empty
            _innerArray(_nameSuffixIndex) = Value
         Else
            Throw New DicomException("Length of family name exceeds 64 characters.")
         End If
      End Set

      Get
         Return _innerArray(_nameSuffixIndex)
      End Get
   End Property

   Private _fullName As String = String.Empty
   ''' Access full person name string representation. According
   ''' to the DICOM standard "^" is used as separator of different
   ''' person name parts.
   Public Property FullName() As String
      Set
         _fullName = Value
         If Not _fullName Is Nothing Then
            Dim s As String()
            Dim i As Integer

            If _fullName.Contains("^") Then
               s = _fullName.Split("^"c)
            Else
               s = _fullName.Split(" "c)
            End If

            i = 0
            Do While i < s.Length
               If s(i).Length < 64 Then
                  If i < _innerArray.Length Then
                     _innerArray(i) = s(i)
                  End If
               Else
                  Throw New DicomException("Length of family name exceeds 64 characters.")
               End If
               i += 1
            Loop
            Dim k As Integer = i
            Do While k < _innerArray.Length
               _innerArray(k) = String.Empty
               k += 1
            Loop
         End If
      End Set

      Get
         If _fullName = String.Empty Then
            _fullName = _innerArray(0)
            Dim isNotNull As Boolean = _fullName <> String.Empty
            Dim i As Integer = 1
            Do While isNotNull AndAlso i < _innerArray.Length
               isNotNull = _innerArray(i) <> String.Empty
               If isNotNull Then
                  _fullName &= "^" & _innerArray(i)
               End If
               i += 1
            Loop
         End If
         Return _fullName
      End Get
   End Property

   ''' Creates a new empty person name instance.
   Public Sub New()
   End Sub

   '' Creates a new person name instance from specified full name.
   '' All person name parts have to be separated by "^" according to
   '' the DICOM standard.
   Public Sub New(ByVal fullNameParam As String)
      FullName = fullNameParam
   End Sub

   '' Creates a new person name instance from the different person name parts.
      Public Sub New(ByVal familyNameParam As String, _
                     ByVal givenNameParam As String, _
                     ByVal middleNameParam As String, _
                     ByVal namePrefixParam As String, _
                     ByVal nameSuffixParam As String)
          FamilyName = familyNameParam
          GivenName = givenNameParam
          MiddleName = middleNameParam
          NamePrefix = namePrefixParam
          NameSuffix = nameSuffixParam
      End Sub

   ''' Return this person name instance's.
   Public Overrides Function ToString() As String
      Return FullName
   End Function
End Class

Private Sub DumpPersonName(ByVal pn As PersonName)
      Dim sMsg As String = String.Format("Family Name: {0}" _
                                         & Constants.vbLf _
                                         & "Given Name: {1}" _
                                         & Constants.vbLf _
                                         & "Middle Name: {2}" _
                                         & Constants.vbLf _
                                         & "Name Prefix: {3}" _
                                         & Constants.vbLf _
                                         & "Name Suffix: {4}", _
                                         pn.FamilyName, _
                                         pn.GivenName, _
                                         pn.MiddleName, _
                                         pn.NamePrefix, _
                                         pn.NameSuffix)
   Debug.WriteLine(sMsg)
End Sub

Private Function GetValueDelegate(ByVal data As String) As PersonName
   Dim t As PersonName = New PersonName(data)
   Return t
End Function

Private Sub DicomDataSet_GetValueWithDelegateExample()
   ' Create a DicomDataSet and add a PatientName
   ' Dicom Spec for Value Representation PN (Person Name)
   ' Elements are in this order:
   ' * family name complex
   ' * given name complex
   ' * middle name
   ' * name prefix
   ' * name suffix.
   Dim ds As DicomDataSet = New DicomDataSet()
   ds.InsertElementAndSetValue(DicomTag.PatientName, "Smith^John^MiddleName^Mr.^III")

   ' Get a PersonName value of an element by specifying a tag, and using a delegate
   ' Use this form when the type is not native to the dataset
   ' The data is extracted from the field as a string and passed to the provided method.
   Dim pn As PersonName = Nothing

   pn = ds.GetValue(Of PersonName)(DicomTag.PatientName, Nothing, AddressOf GetValueDelegate)
   DumpPersonName(pn)

   ' Another overload, specifying parent element
   pn = ds.GetValue(Of PersonName)(Nothing, True, DicomTag.PatientName, Nothing, AddressOf GetValueDelegate)
   DumpPersonName(pn)

   ' Another overload, this time passing in the DICOM element instead of a tag
   Dim element As DicomElement = ds.FindFirstElement(Nothing, DicomTag.PatientName, True)
   pn = ds.GetValue(Of PersonName)(element, Nothing, AddressOf GetValueDelegate)
   DumpPersonName(pn)
End Sub